﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>SessionsService </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="SessionsService ">
    <meta name="generator" content="docfx 2.59.2.0">
    
    <link rel="shortcut icon" href="../../favicon.ico">
    <link rel="stylesheet" href="../../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../../styles/docfx.css">
    <link rel="stylesheet" href="../../styles/main.css">
    <link rel="stylesheet" href="../../styles/socialbar.css">
    <link rel="stylesheet" href="../../styles/header.css">
    <link rel="stylesheet" href="../../styles/version.css">
    <link href="https://fonts.googleapis.com/css?family=Roboto:400,100,300,500,700,100italic,300italic,400italic" rel="stylesheet" type="text/css">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
    <meta property="docfx:navrel" content="../../toc.html">
    <meta property="docfx:tocrel" content="../toc.html">
    <meta property="docfx:uid" content="emby.restapi/tag/SessionsService">
    
    <meta property="docfx:rel" content="../../">
    
    <script type="text/javascript" src="../../nav.js"></script>
    <script type="text/javascript" src="../toc.js"></script>
  
  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>
        
        <div class="mb-socials-heading" style="height: 40px;">
        	<div class="mb-socials-heading-inner container">
        		<div class="mb-socials-heading-right">
        			<div class="mb-socials-list">
                          
        				<div class="mb-socials-item facebook">
        					<a class="mb-socials-item-link" target="_blank" href="https://facebook.com/embyapp"></a>
        					<div class="mb-socials-item-popup">
        						<span>Facebook</span>
        					</div>
        				</div><div class="mb-socials-item twitter">
        					<a class="mb-socials-item-link" target="_blank" href="https://twitter.com/embyapp"></a>
        					<div class="mb-socials-item-popup">
        						<span>Twitter</span>
        					</div>
        				</div>
        				<div class="mb-socials-item pinterest">
        					<a class="mb-socials-item-link" target="_blank" href="https://www.pinterest.com/emby0240/emby-news/"></a>
        					<div class="mb-socials-item-popup">
        						<span>Pinterest</span>
        					</div>
        				</div>
        				<div class="mb-socials-item tumblr">
        					<a class="mb-socials-item-link" target="_blank" href="https://embyapp.tumblr.com/"></a>
        					<div class="mb-socials-item-popup">
        						<span>Tumblr</span>
        					</div>
        				</div>
        				<div class="mb-socials-item github">
        					<a class="mb-socials-item-link" target="_blank" href="https://github.com/MediaBrowser"></a>
        					<div class="mb-socials-item-popup">
        						<span>GitHub</span>
        					</div>
        				</div><div class="mb-socials-item rss">
        					<a class="mb-socials-item-link" target="_blank" href="https://emby.media/blog.xml"></a>
        					<div class="mb-socials-item-popup">
        						<span>RSS</span>
        					</div>
        				</div>
                          
        			</div>
        		</div>
        	</div>
        </div>
        <div class="container">
        	<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
        		  
        		  <a class="navbar-brand" href="../../index.html">
        		    <img id="logo" class="svg" src="../../images/emby_dev_logo.png" alt="">
        		  </a>
        		  <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
        			<span class="sr-only">Toggle navigation</span>
        			<span class="icon-bar"></span>
        			<span class="icon-bar"></span>
        			<span class="icon-bar"></span>
        		  </button>
        		<div class="collapse navbar-collapse" id="navbar">
        			
        			<ul class="nav level1 navbar-nav">
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../index.html" title="DEV Home">DEV Home</a>
        			      </li>
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../doc/index.html" title="Documentation">Documentation</a>
        			      </li>
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../reference/index.html" title="Reference">Reference</a>
        			      </li>
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../download/index.html" title="Download">Download</a>
        			      </li>
        			</ul>		</div>
        	</nav>
        </div>
        <div class="nav-overlay d-none"></div>        
        <div class="subnav navbar navbar-default">
          <div class="container">
            <div class="hide-when-search" id="breadcrumb">
        	  <ul class="breadcrumb">
        		<li></li>
        	  </ul>
        	</div>
        
        	<div class="breadcrumpsearch">
        	  <form class="navbar-form navbar-right" role="search" id="search">
        		<div class="form-group">
        		  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
        		</div>
        	  </form>
        	</div>
          </div>
        </div>
      </header>
      <div class="container body-content">
        
        <div id="search-results">
          <div class="search-list">Search Results for <span></span></div>
          <div class="sr-items">
            <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
          </div>
          <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
        </div>
      </div>
      <div role="main" class="container body-content hide-when-search">
        
        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="emby.restapi/tag/SessionsService">
<div class="refdoc">

<h1 id="emby_restapi_tag_SessionsService" data-uid="emby.restapi/tag/SessionsService" class="text-capitalize text-break">SessionsService</h1>


<a href="https://dev.emby.media/doc/restapi/Remote-Control.html" class=""><p>API Documentation: Remote control</p>
</a>

 <a class="xref" href="SessionsService/deleteAuthKeysByKey.html"><h3 id="emby_restapi_tag_SessionsService" data-uid="emby.restapi/deleteAuthKeysByKey/operationlistitem" class="text-capitalize">deleteAuthKeysByKey</h3></a>
<div class="codewrapper">
  <pre><code class="lang-restApi hljs"><span class="opspan opspan-delete">delete</span> /Auth/Keys/{Key}</code></pre>
</div>
 <a class="xref" href="SessionsService/deleteSessionsByIdUsersByUserid.html"><h3 id="emby_restapi_tag_SessionsService" data-uid="emby.restapi/deleteSessionsByIdUsersByUserid/operationlistitem" class="text-capitalize">deleteSessionsByIdUsersByUserid</h3></a>
<div class="codewrapper">
  <pre><code class="lang-restApi hljs"><span class="opspan opspan-delete">delete</span> /Sessions/{Id}/Users/{UserId}</code></pre>
</div>
<div class="markdown level1 summary"><p>Removes an additional user from a session</p>
</div>
 <a class="xref" href="SessionsService/getAuthKeys.html"><h3 id="emby_restapi_tag_SessionsService" data-uid="emby.restapi/getAuthKeys/operationlistitem" class="text-capitalize">getAuthKeys</h3></a>
<div class="codewrapper">
  <pre><code class="lang-restApi hljs"><span class="opspan opspan-get">get</span> /Auth/Keys</code></pre>
</div>
 <a class="xref" href="SessionsService/getAuthProviders.html"><h3 id="emby_restapi_tag_SessionsService" data-uid="emby.restapi/getAuthProviders/operationlistitem" class="text-capitalize">getAuthProviders</h3></a>
<div class="codewrapper">
  <pre><code class="lang-restApi hljs"><span class="opspan opspan-get">get</span> /Auth/Providers</code></pre>
</div>
 <a class="xref" href="SessionsService/getSessions.html"><h3 id="emby_restapi_tag_SessionsService" data-uid="emby.restapi/getSessions/operationlistitem" class="text-capitalize">getSessions</h3></a>
<div class="codewrapper">
  <pre><code class="lang-restApi hljs"><span class="opspan opspan-get">get</span> /Sessions</code></pre>
</div>
<div class="markdown level1 summary"><p>Gets a list of sessions</p>
</div>
 <a class="xref" href="SessionsService/getSessionsPlayqueue.html"><h3 id="emby_restapi_tag_SessionsService" data-uid="emby.restapi/getSessionsPlayqueue/operationlistitem" class="text-capitalize">getSessionsPlayqueue</h3></a>
<div class="codewrapper">
  <pre><code class="lang-restApi hljs"><span class="opspan opspan-get">get</span> /Sessions/PlayQueue</code></pre>
</div>
<div class="markdown level1 summary"><p>Gets a the current play queue from a session</p>
</div>
 <a class="xref" href="SessionsService/postAuthKeys.html"><h3 id="emby_restapi_tag_SessionsService" data-uid="emby.restapi/postAuthKeys/operationlistitem" class="text-capitalize">postAuthKeys</h3></a>
<div class="codewrapper">
  <pre><code class="lang-restApi hljs"><span class="opspan opspan-post">post</span> /Auth/Keys</code></pre>
</div>
 <a class="xref" href="SessionsService/postAuthKeysByKeyDelete.html"><h3 id="emby_restapi_tag_SessionsService" data-uid="emby.restapi/postAuthKeysByKeyDelete/operationlistitem" class="text-capitalize">postAuthKeysByKeyDelete</h3></a>
<div class="codewrapper">
  <pre><code class="lang-restApi hljs"><span class="opspan opspan-post">post</span> /Auth/Keys/{Key}/Delete</code></pre>
</div>
 <a class="xref" href="SessionsService/postSessionsByIdCommand.html"><h3 id="emby_restapi_tag_SessionsService" data-uid="emby.restapi/postSessionsByIdCommand/operationlistitem" class="text-capitalize">postSessionsByIdCommand</h3></a>
<div class="codewrapper">
  <pre><code class="lang-restApi hljs"><span class="opspan opspan-post">post</span> /Sessions/{Id}/Command</code></pre>
</div>
<div class="markdown level1 summary"><p>Issues a system command to a client</p>
</div>
 <a class="xref" href="SessionsService/postSessionsByIdCommandByCommand.html"><h3 id="emby_restapi_tag_SessionsService" data-uid="emby.restapi/postSessionsByIdCommandByCommand/operationlistitem" class="text-capitalize">postSessionsByIdCommandByCommand</h3></a>
<div class="codewrapper">
  <pre><code class="lang-restApi hljs"><span class="opspan opspan-post">post</span> /Sessions/{Id}/Command/{Command}</code></pre>
</div>
<div class="markdown level1 summary"><p>Issues a system command to a client</p>
</div>
 <a class="xref" href="SessionsService/postSessionsByIdMessage.html"><h3 id="emby_restapi_tag_SessionsService" data-uid="emby.restapi/postSessionsByIdMessage/operationlistitem" class="text-capitalize">postSessionsByIdMessage</h3></a>
<div class="codewrapper">
  <pre><code class="lang-restApi hljs"><span class="opspan opspan-post">post</span> /Sessions/{Id}/Message</code></pre>
</div>
<div class="markdown level1 summary"><p>Issues a command to a client to display a message to the user</p>
</div>
 <a class="xref" href="SessionsService/postSessionsByIdPlaying.html"><h3 id="emby_restapi_tag_SessionsService" data-uid="emby.restapi/postSessionsByIdPlaying/operationlistitem" class="text-capitalize">postSessionsByIdPlaying</h3></a>
<div class="codewrapper">
  <pre><code class="lang-restApi hljs"><span class="opspan opspan-post">post</span> /Sessions/{Id}/Playing</code></pre>
</div>
<div class="markdown level1 summary"><p>Instructs a session to play an item</p>
</div>
 <a class="xref" href="SessionsService/postSessionsByIdPlayingByCommand.html"><h3 id="emby_restapi_tag_SessionsService" data-uid="emby.restapi/postSessionsByIdPlayingByCommand/operationlistitem" class="text-capitalize">postSessionsByIdPlayingByCommand</h3></a>
<div class="codewrapper">
  <pre><code class="lang-restApi hljs"><span class="opspan opspan-post">post</span> /Sessions/{Id}/Playing/{Command}</code></pre>
</div>
<div class="markdown level1 summary"><p>Issues a playstate command to a client</p>
</div>
 <a class="xref" href="SessionsService/postSessionsByIdSystemByCommand.html"><h3 id="emby_restapi_tag_SessionsService" data-uid="emby.restapi/postSessionsByIdSystemByCommand/operationlistitem" class="text-capitalize">postSessionsByIdSystemByCommand</h3></a>
<div class="codewrapper">
  <pre><code class="lang-restApi hljs"><span class="opspan opspan-post">post</span> /Sessions/{Id}/System/{Command}</code></pre>
</div>
<div class="markdown level1 summary"><p>Issues a system command to a client</p>
</div>
 <a class="xref" href="SessionsService/postSessionsByIdUsersByUserid.html"><h3 id="emby_restapi_tag_SessionsService" data-uid="emby.restapi/postSessionsByIdUsersByUserid/operationlistitem" class="text-capitalize">postSessionsByIdUsersByUserid</h3></a>
<div class="codewrapper">
  <pre><code class="lang-restApi hljs"><span class="opspan opspan-post">post</span> /Sessions/{Id}/Users/{UserId}</code></pre>
</div>
<div class="markdown level1 summary"><p>Adds an additional user to a session</p>
</div>
 <a class="xref" href="SessionsService/postSessionsByIdUsersByUseridDelete.html"><h3 id="emby_restapi_tag_SessionsService" data-uid="emby.restapi/postSessionsByIdUsersByUseridDelete/operationlistitem" class="text-capitalize">postSessionsByIdUsersByUseridDelete</h3></a>
<div class="codewrapper">
  <pre><code class="lang-restApi hljs"><span class="opspan opspan-post">post</span> /Sessions/{Id}/Users/{UserId}/Delete</code></pre>
</div>
<div class="markdown level1 summary"><p>Removes an additional user from a session</p>
</div>
 <a class="xref" href="SessionsService/postSessionsByIdViewing.html"><h3 id="emby_restapi_tag_SessionsService" data-uid="emby.restapi/postSessionsByIdViewing/operationlistitem" class="text-capitalize">postSessionsByIdViewing</h3></a>
<div class="codewrapper">
  <pre><code class="lang-restApi hljs"><span class="opspan opspan-post">post</span> /Sessions/{Id}/Viewing</code></pre>
</div>
<div class="markdown level1 summary"><p>Instructs a session to browse to an item or view</p>
</div>
 <a class="xref" href="SessionsService/postSessionsCapabilities.html"><h3 id="emby_restapi_tag_SessionsService" data-uid="emby.restapi/postSessionsCapabilities/operationlistitem" class="text-capitalize">postSessionsCapabilities</h3></a>
<div class="codewrapper">
  <pre><code class="lang-restApi hljs"><span class="opspan opspan-post">post</span> /Sessions/Capabilities</code></pre>
</div>
<div class="markdown level1 summary"><p>Updates capabilities for a device</p>
</div>
 <a class="xref" href="SessionsService/postSessionsCapabilitiesFull.html"><h3 id="emby_restapi_tag_SessionsService" data-uid="emby.restapi/postSessionsCapabilitiesFull/operationlistitem" class="text-capitalize">postSessionsCapabilitiesFull</h3></a>
<div class="codewrapper">
  <pre><code class="lang-restApi hljs"><span class="opspan opspan-post">post</span> /Sessions/Capabilities/Full</code></pre>
</div>
<div class="markdown level1 summary"><p>Updates capabilities for a device</p>
</div>
 <a class="xref" href="SessionsService/postSessionsLogout.html"><h3 id="emby_restapi_tag_SessionsService" data-uid="emby.restapi/postSessionsLogout/operationlistitem" class="text-capitalize">postSessionsLogout</h3></a>
<div class="codewrapper">
  <pre><code class="lang-restApi hljs"><span class="opspan opspan-post">post</span> /Sessions/Logout</code></pre>
</div>
<div class="markdown level1 summary"><p>Reports that a session has ended</p>
</div>

</div>
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                </ul>
              </div>
              <div class="sdkversion Release">
                  SDK <span class="sdkVersionSpan"></span>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
                <h5>On this Page</h5>
                <div></div>
              </nav>
            </div>
          </div>
        </div>
      </div>
      
      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to Top</a>
            </span>
            Copyright 2022 © EMBY LLC.  Please see our <a class="lnk" href="https://emby.media/terms.html">terms of use</a> and <a class="lnk" href="https://emby.media/privacy.html">privacy policy</a>.
            
          </div>
        </div>
      </footer>
    </div>
    
    <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../../searchIndex.js"></script>
    <script type="text/javascript" src="../../styles/lunr.min.js"></script>
    <script type="text/javascript" src="../../styles/docfx.js"></script>
    <script type="text/javascript" src="../../styles/main.js"></script>
  </body>
</html>
